chore: improve e2e signalling test tooling by lukasIO · Pull Request #1998 · livekit/client-sdk-js

lukasIO · 2026-07-09T14:23:41Z

changeset-bot · 2026-07-09T14:23:49Z

⚠️ No Changeset found

Latest commit: ab462dc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2026-07-09T14:25:44Z

size-limit report 📦

Path	Size
dist/livekit-client.esm.mjs	104.62 KB (0%)
dist/livekit-client.umd.js	113.68 KB (0%)

1egoman

Generally makes sense to me!

Just wanted to confirm one thing to make sure I am reading this right - running npm test wouldn't cause the e2e tests to run by default correct? You'd need to explictly run test:e2e and set the relevant LK_ prefixed env vars to the server environment?

1egoman · 2026-07-10T15:23:42Z

+  websocketTimeout: 5_000,
+});
+
+const sleep = (ms: number) => new Promise((r) => setTimeout(r, ms));


nitpick: could this be imported from here instead?

1egoman · 2026-07-10T15:29:12Z

+    it('stays connected past the ping timeout while the server pongs', async () => {
+      const onClose = vi.fn();
+      await join('happy');
+      client.onClose = onClose;
+      // Server ping timeout is 3s; a healthy pong loop must keep us alive.
+      await sleep(4_000);
+      expect(onClose).not.toHaveBeenCalled();
+      expect(client.currentState).toBe(SignalConnectionState.CONNECTED);
+    });


thought: I added this subscribeToEvents test helper here when building data tracks (and I've also used it in the data streams v2 pr). I found it really nice for testing classes which emit events rather than manually registering / unregistering vi.fn() type mocks.

I realize SignalClient isn't an EventEmitter today but that helper looks like it could maybe be useful here as well. If you agree, maybe it should be converted to an EventEmitter and used here too.

If you want to invest in this subscribeToEvents helper more, it might be worth also adding something in the AGENTS.md file about it.

I'll leave converting SignalClient to an EventEmitter for a potential follow up

1egoman · 2026-07-10T15:42:09Z

+  const binary = join(serverDir, 'bin', 'test-server');
+  if (!process.env.LK_E2E_SKIP_BUILD) {
+    try {
+      execFileSync('go', ['build', '-o', 'bin/test-server', './cmd/test-server'], {


question(non-blocking): is this guaranteed to always be the right command, or would it be better to call out to some sort build tool (maybe mage? Or maybe a bespoke script?) in the livekit/livekit repo?

Still am somewhat curious here, is there a more robust way to handle this?

it's the command that is also used in the server repo for the test server.
note that this is only ever used for local tests against custom server changes if we're not pulling in the existing docker image (which is what the CI does).

1egoman · 2026-07-10T15:44:27Z

+  ttlSeconds?: number;
+}
+
+export async function createToken(opts: TokenOptions = {}): Promise<string> {


question(non-blocking): would it be a good idea to pull in the node server sdk as a dev dependency to generate this token? Or would that be nonviable since you need to add the custom lk.mock attribute?

I mostly bring it up because this could potentially silently break if new fields were added to tokens that should be included by default in newly generated ones. Relying on the existing library should make that a non issue.

1egoman · 2026-07-10T15:46:30Z

+    browser: {
+      enabled: true,
+      provider: playwright(),
+      headless: true,
+      instances: [{ browser: 'chromium' }],
+    },


thought: Is there benefit to running this across multiple browsers? Guessing not for signaling, but maybe there could be for the follow up peer connection management state machine work?

1egoman · 2026-07-10T15:48:51Z

+      - name: Run signal e2e tests
+        run: pnpm test:e2e 2>&1 | tee e2e.log
+        env:
+          # Connect to the test-server service above (validate + WS on 9999).
+          LK_TEST_SERVER_URL: ws://127.0.0.1:9999


question: Just curious, how stable have these been so far in ci?

very stable so far!

1egoman · 2026-07-24T16:31:17Z

+  const binary = join(serverDir, 'bin', 'test-server');
+  if (!process.env.LK_E2E_SKIP_BUILD) {
+    try {
+      execFileSync('go', ['build', '-o', 'bin/test-server', './cmd/test-server'], {


Still am somewhat curious here, is there a more robust way to handle this?

lukasIO added 2 commits July 9, 2026 16:22

add e2e signalling tests

f3a1c57

run action for testing

7084276

lukasIO requested review from 1egoman and xianshijing-lk as code owners July 9, 2026 14:23

This comment was marked as resolved.

Sign in to view

remove action test branch

d0e13a6

lint

ec91f64

This comment was marked as resolved.

Sign in to view

lukasIO added 4 commits July 9, 2026 16:33

cleaner unref handling

e82f68e

clean up deps

5613db8

cleanup

597b077

use canonical TS version

8c66b0b

This comment was marked as resolved.

Sign in to view

fix config

3e9d4a1

1egoman reviewed Jul 10, 2026

View reviewed changes

lukasIO added 2 commits July 22, 2026 15:59

Merge branch 'main' into lukas/signal-e2e

05d7561

address comments

b1c9546

lukasIO requested a review from 1egoman July 24, 2026 14:58

1egoman approved these changes Jul 24, 2026

View reviewed changes

lukasIO changed the title ~~add e2e signalling tests~~ chore: improve e2e signalling test tooling Jul 27, 2026

lukasIO added 3 commits July 27, 2026 11:46

use livekit-server-sdk for token generation

57998b8

Merge branch 'main' into lukas/signal-e2e

74ea8ad

use bundler resolution in tsconfig

ab462dc

lukasIO merged commit 042f1c1 into main Jul 27, 2026
6 checks passed

lukasIO deleted the lukas/signal-e2e branch July 27, 2026 09:58

Uh oh!

Conversation

lukasIO commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

This comment was marked as resolved.

Uh oh!

github-actions Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

1egoman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

1egoman Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

1egoman Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lukasIO commented Jul 9, 2026 •

edited

Loading

changeset-bot Bot commented Jul 9, 2026 •

edited

Loading

github-actions Bot commented Jul 9, 2026 •

edited

Loading

1egoman Jul 10, 2026 •

edited

Loading

1egoman Jul 10, 2026 •

edited

Loading